<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Core Plot (iOS): CPTPlotArea Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="core-plot-logo.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Core Plot (iOS)
   
   </div>
   <div id="projectbrief">Cocoa plotting framework for Mac OS X and iOS</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Animation&#160;&&#160;Constants</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('interface_c_p_t_plot_area.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">CPTPlotArea Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="CPTPlotArea" --><!-- doxytag: inherits="CPTAnnotationHostLayer" -->
<p>A layer representing the actual plotting area of a graph.  
 <a href="interface_c_p_t_plot_area.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CPTPlotArea:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="interface_c_p_t_plot_area__inherit__graph.png" border="0" usemap="#_c_p_t_plot_area_inherit__map" alt="Inheritance graph"/></div>
<map name="_c_p_t_plot_area_inherit__map" id="_c_p_t_plot_area_inherit__map">
<area shape="rect" id="node2" href="interface_c_p_t_annotation_host_layer.html" title="A container layer for annotations." alt="" coords="150,326,332,357"/><area shape="rect" id="node4" href="interface_c_p_t_layer.html" title="Base class for all Core Animation layers in Core Plot." alt="" coords="201,246,281,277"/><area shape="rect" id="node6" href="http://developer.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CALayer_class/Introduction/Introduction.html" title="CALayer" alt="" coords="140,166,213,197"/><area shape="rect" id="node8" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSObject_Class/Reference/Reference.html" title="NSObject" alt="" coords="5,86,85,117"/><area shape="rect" id="node10" href="http://developer.apple.com/iPhone/library/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="117,6,235,37"/><area shape="rect" id="node14" href="protocol_c_p_t_responder-p.html" title="The basis of all event processing in Core Plot." alt="" coords="238,166,375,197"/><area shape="rect" id="node12" href="http://www.devworld.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CAMediaTiming_protocol/Introduction/Introduction.html" title="\&lt;CAMediaTiming&#45;p\&gt;" alt="" coords="109,86,269,117"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for CPTPlotArea:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="interface_c_p_t_plot_area__coll__graph.png" border="0" usemap="#_c_p_t_plot_area_coll__map" alt="Collaboration graph"/></div>
<map name="_c_p_t_plot_area_coll__map" id="_c_p_t_plot_area_coll__map">
<area shape="rect" id="node2" href="interface_c_p_t_annotation_host_layer.html" title="A container layer for annotations." alt="" coords="150,326,332,357"/><area shape="rect" id="node4" href="interface_c_p_t_layer.html" title="Base class for all Core Animation layers in Core Plot." alt="" coords="201,246,281,277"/><area shape="rect" id="node6" href="http://developer.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CALayer_class/Introduction/Introduction.html" title="CALayer" alt="" coords="140,166,213,197"/><area shape="rect" id="node8" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSObject_Class/Reference/Reference.html" title="NSObject" alt="" coords="5,86,85,117"/><area shape="rect" id="node10" href="http://developer.apple.com/iPhone/library/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="117,6,235,37"/><area shape="rect" id="node14" href="protocol_c_p_t_responder-p.html" title="The basis of all event processing in Core Plot." alt="" coords="238,166,375,197"/><area shape="rect" id="node12" href="http://www.devworld.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CAMediaTiming_protocol/Introduction/Introduction.html" title="\&lt;CAMediaTiming&#45;p\&gt;" alt="" coords="109,86,269,117"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_c_p_t_plot_area-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Instance Methods</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Axis set layer management</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_p_t_plot_area.html#a5eab7932d8e866d0169b3d1dbc33201b">updateAxisSetLayersForType:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks for the presence of the specified layer group and adds or removes it as needed.  <a href="#a5eab7932d8e866d0169b3d1dbc33201b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_p_t_plot_area.html#a0066c0b6b579af4650d53270e1e82381">setAxisSetLayersForType:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Ensures that a group layer is set for the given layer type.  <a href="#a0066c0b6b579af4650d53270e1e82381"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(unsigned)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_p_t_plot_area.html#a86af66098849fb0d8ecf08d224150023">sublayerIndexForAxis:layerType:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the sublayer index for the given layer type and axis.  <a href="#a86af66098849fb0d8ecf08d224150023"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Layers</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b44df832f65790aa95016d809172745"></a><!-- doxytag: member="CPTPlotArea::minorGridLineGroup" ref="a3b44df832f65790aa95016d809172745" args="" -->
<a class="el" href="interface_c_p_t_grid_line_group.html">CPTGridLineGroup</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#a3b44df832f65790aa95016d809172745">minorGridLineGroup</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The parent layer for all minor grid lines. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3d620f1ed1328411d1c35830ccfb854"></a><!-- doxytag: member="CPTPlotArea::majorGridLineGroup" ref="ab3d620f1ed1328411d1c35830ccfb854" args="" -->
<a class="el" href="interface_c_p_t_grid_line_group.html">CPTGridLineGroup</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#ab3d620f1ed1328411d1c35830ccfb854">majorGridLineGroup</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The parent layer for all major grid lines. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dafaa321e099f83ac93605e885443da"></a><!-- doxytag: member="CPTPlotArea::axisSet" ref="a7dafaa321e099f83ac93605e885443da" args="" -->
<a class="el" href="interface_c_p_t_axis_set.html">CPTAxisSet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#a7dafaa321e099f83ac93605e885443da">axisSet</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The axis set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedf092dfd6a572e23442111e9a1affd8"></a><!-- doxytag: member="CPTPlotArea::plotGroup" ref="aedf092dfd6a572e23442111e9a1affd8" args="" -->
<a class="el" href="interface_c_p_t_plot_group.html">CPTPlotGroup</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#aedf092dfd6a572e23442111e9a1affd8">plotGroup</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The plot group. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0a0b57d1deb8f02ebabfc34793cd579"></a><!-- doxytag: member="CPTPlotArea::axisLabelGroup" ref="ac0a0b57d1deb8f02ebabfc34793cd579" args="" -->
<a class="el" href="interface_c_p_t_axis_label_group.html">CPTAxisLabelGroup</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#ac0a0b57d1deb8f02ebabfc34793cd579">axisLabelGroup</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The parent layer for all axis labels. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ab0f70db90e5e164e7fa440790af49a"></a><!-- doxytag: member="CPTPlotArea::axisTitleGroup" ref="a5ab0f70db90e5e164e7fa440790af49a" args="" -->
<a class="el" href="interface_c_p_t_axis_label_group.html">CPTAxisLabelGroup</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#a5ab0f70db90e5e164e7fa440790af49a">axisTitleGroup</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The parent layer for all axis titles. <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Layer ordering</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSArray_Class/NSArray.html">NSArray</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#a9e425efc7501c6463ca2a05c7ae4d72f">topDownLayerOrder</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">An array of graph layers to be drawn in an order other than the default.  <a href="#a9e425efc7501c6463ca2a05c7ae4d72f"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Decorations</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab77ea92ee3ce64f2a8507324f4048290"></a><!-- doxytag: member="CPTPlotArea::borderLineStyle" ref="ab77ea92ee3ce64f2a8507324f4048290" args="" -->
<a class="el" href="interface_c_p_t_line_style.html">CPTLineStyle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#ab77ea92ee3ce64f2a8507324f4048290">borderLineStyle</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The line style for the layer border. If nil, the border is not drawn. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38950c31448c74d346eb8f7fcee91ff9"></a><!-- doxytag: member="CPTPlotArea::fill" ref="a38950c31448c74d346eb8f7fcee91ff9" args="" -->
<a class="el" href="interface_c_p_t_fill.html">CPTFill</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_plot_area.html#a38950c31448c74d346eb8f7fcee91ff9">fill</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The fill for the layer background. If nil, the layer background is not filled. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A layer representing the actual plotting area of a graph. </p>
<p>All plots are drawn inside this area while axes, titles, and borders may fall outside. The layers are arranged so that the graph elements are drawn in the following order:</p>
<ol type="1">
<li>Background fill</li>
<li>Minor grid lines</li>
<li>Major grid lines</li>
<li>Background border</li>
<li>Axis lines with major and minor tick marks</li>
<li>Plots</li>
<li>Axis labels</li>
<li>Axis titles </li>
</ol>
</div><hr/><h2>Method Documentation</h2>
<a class="anchor" id="a0066c0b6b579af4650d53270e1e82381"></a><!-- doxytag: member="CPTPlotArea::setAxisSetLayersForType:" ref="a0066c0b6b579af4650d53270e1e82381" args="(CPTGraphLayerType layerType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) <a class="el" href="interface_c_p_t_plot_area.html#a0066c0b6b579af4650d53270e1e82381">setAxisSetLayersForType:</a> </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="_c_p_t_graph_8h.html#a516b503d3a0be51b245e936ae5049b07">CPTGraphLayerType</a>)&#160;</td>
          <td class="paramname"><em>layerType</em></td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Ensures that a group layer is set for the given layer type. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">layerType</td><td>The layer type being updated. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a86af66098849fb0d8ecf08d224150023"></a><!-- doxytag: member="CPTPlotArea::sublayerIndexForAxis:layerType:" ref="a86af66098849fb0d8ecf08d224150023" args="(CPTAxis *axis,[layerType] CPTGraphLayerType layerType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (unsigned) sublayerIndexForAxis: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_c_p_t_axis.html">CPTAxis</a> *)&#160;</td>
          <td class="paramname"><em>axis</em></td>
        </tr>
        <tr>
          <td class="paramkey">layerType:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="_c_p_t_graph_8h.html#a516b503d3a0be51b245e936ae5049b07">CPTGraphLayerType</a>)&#160;</td>
          <td class="paramname"><em>layerType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Computes the sublayer index for the given layer type and axis. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">axis</td><td>The axis of interest. </td></tr>
    <tr><td class="paramname">layerType</td><td>The layer type being updated. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The sublayer index for the given layer type. </dd></dl>

</div>
</div>
<a class="anchor" id="a5eab7932d8e866d0169b3d1dbc33201b"></a><!-- doxytag: member="CPTPlotArea::updateAxisSetLayersForType:" ref="a5eab7932d8e866d0169b3d1dbc33201b" args="(CPTGraphLayerType layerType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) <a class="el" href="interface_c_p_t_plot_area.html#a5eab7932d8e866d0169b3d1dbc33201b">updateAxisSetLayersForType:</a> </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="_c_p_t_graph_8h.html#a516b503d3a0be51b245e936ae5049b07">CPTGraphLayerType</a>)&#160;</td>
          <td class="paramname"><em>layerType</em></td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Checks for the presence of the specified layer group and adds or removes it as needed. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">layerType</td><td>The layer type being updated. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a9e425efc7501c6463ca2a05c7ae4d72f"></a><!-- doxytag: member="CPTPlotArea::topDownLayerOrder" ref="a9e425efc7501c6463ca2a05c7ae4d72f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- CPTPlotArea:<code> [read, write, retain]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>An array of graph layers to be drawn in an order other than the default. </p>
<p>The array should reference the layers using the constants defined in <a class="el" href="_c_p_t_graph_8h.html#a516b503d3a0be51b245e936ae5049b07" title="Enumeration of graph layers.">CPTGraphLayerType</a>. Layers should be specified in order starting from the top layer. Only the layers drawn out of the default order need be specified; all others will automatically be placed at the bottom of the view in their default order.</p>
<p>If this property is nil, the layers will be drawn in the default order (bottom to top):</p>
<ol type="1">
<li>Minor grid lines</li>
<li>Major grid lines</li>
<li>Axis lines, including the tick marks</li>
<li>Plots</li>
<li>Axis labels</li>
<li>Axis titles</li>
</ol>
<p>Example usage: <code>[graph setTopDownLayerOrder:[<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSArray_Class/NSArray.html">NSArray</a> arrayWithObjects: [<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSNumber_Class/Reference/Reference.html">NSNumber</a> numberWithInt:CPTGraphLayerTypePlots], [<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSNumber_Class/Reference/Reference.html">NSNumber</a> numberWithInt:CPTGraphLayerTypeAxisLabels], [<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSNumber_Class/Reference/Reference.html">NSNumber</a> numberWithInt:CPTGraphLayerTypeMajorGridLines], ..., nil]];</code> </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Source/<a class="el" href="_c_p_t_plot_area_8h_source.html">CPTPlotArea.h</a></li>
<li>Source/CPTPlotArea.m</li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="interface_c_p_t_plot_area.html">CPTPlotArea</a>      </li>

    <li class="footer">Generated by <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a></li>
   </ul>
 </div>


</body>
</html>
